Configuring Push Notification Servers
The Push Notification Servers table lets you configure up to five Push Notification Servers. The device uses this table to determine which Push Notification Server to send push notification requests for a specific user. The device searches the table for a row that is configured with the user's 'pn-provider' parameter value and if located, sends the push notification request to the Push Notification Server, using the address of the associated Remote Web Service.
The Push Notification Service uses Push Notification Servers to send push notifications to "wake" end-user equipment (typically, mobile platforms) that have gone to "sleep" (e.g., to save resources such as battery life) so that they can receive traffic. The device can handle calls (and registration) for such SIP user agents (UAs), by interoperating with these third-party, Push Notification Servers (over HTTP, using RESTful APIs). For more information on Push Notification Service, see Configuring Push Notification Service.
Before you can configure a Push Notification Server in this table, you need to configure a Remote Web Service (HTTP-based server) to represent the Push Notification Server. The Remote Web Service defines the actual address (and other required parameters) of the server. You must configure the Remote Web Service with the 'Type' parameter set to General. To configure Remote Web Services, see Configuring Remote Web Services.
The following procedure describes how to configure Push Notification Servers through the Web interface. You can also configure it through ini file [PushNotificationServers] or CLI (configure voip > sip-definition push-notification-servers).
| ➢ | To configure Push Notification Server: |
| 1. | Open the Push Notification Servers table (Setup menu > Signaling & Media tab > SIP Definitions folder > Push Notification Servers). |
| 2. | Click New; the following dialog box appears: |
| 3. | Configure a Push Notification Server according to the parameters described in the table below. |
| 4. | Click Apply. |
Push Notification Servers Table Parameter Descriptions
|
Parameter |
Description |
||||||
|---|---|---|---|---|---|---|---|
|
'Index' [Index] |
Defines an index number for the new table row. Note: Each row must be configured with a unique index. |
||||||
|
'Provider' provider [Provider] |
Defines the type of the Push Notification Service. The type of the service provider is indicated in the SIP Contact header's 'pn-provider' parameter of the REGISTER message that is sent by the user to the device. For example, Android-based mobile phone platforms typically use Firebase Cloud Messaging (FCM) for its Push Notification Service. The value of the 'pn-provider' parameter for this service type is "fcm". Therefore, you would need to configure the 'Provider' parameter to "fcm" (without quotation marks). The valid value is a string of up to 10 characters. By default, no value is defined. To denote any provider, use the asterisk (*) wildcard character. Note:
|
||||||
|
'Remote Web Service' remote-http-service [RemoteHTTPService] |
Assigns a Remote Web Service, which defines the URL address (and other related parameters) of the HTTP-based Push Notification Server. To configure Remote Web Services, see Configuring Remote Web Services. Note: The parameter is mandatory. |
||||||
|
'Protocol' protocol [Protocol] |
Defines the protocol for exchanging information between the device and the Push Notification Server.
|